package com.wanna.common.doc.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 返回值 参数
 *
 * @author wanna
 * @since 2018-11-27
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface ApiField {
    /**
     * 字段描述
     *
     * @return description
     */
    String description() default "";

    /**
     * 字段是否必填
     *
     * @return true or false
     */
    boolean required() default true;

    /**
     * 字段类型
     *
     * @return class
     */
    Class cls() default Object.class;

    /**
     * 集合类型
     *
     * @return true or false
     */
    boolean collectionType() default false;
}
